Pular para o conteúdo principal

Competência

Título: Competência do Documento
Descrição: Competência do Documento (Mês/Trimestre/Semestre + Ano).

Propriedades​

Validar competência​

  • Tipo: radio
  • Nome: VALIDATE_COMPETENCY
  • Valor Padrão: ignore
  • Opções:
    • Não validar: ignore
    • Uma única competência: validate-single
    • Mais de uma competência: validate-multiple

Tipo da competência​

Variante exibida quando é validada uma única competência.

  • Tipo: select
  • Nome: COMPETENCY_TYPE
  • Condições:
    • Quando VALIDATE_COMPETENCY é validate-single
  • Opções:
    • Mês: month
    • Trimestre: quarter
    • Semestre: semester
    • Ano: year

Tipo da competência​

Variante exibida quando são validadas mais de uma competência.

  • Tipo: select
  • Nome: COMPETENCY_TYPE
  • Condições:
    • Quando VALIDATE_COMPETENCY é validate-multiple
  • Opções:
    • Mês: month
    • Trimestre: quarter
    • Semestre: semester
    • Ano: year

Quantidade de competências​

  • Tipo: number
  • Nome: COMPETENCY_COUNT
  • Valor Padrão: 1
  • Condições:
    • Quando VALIDATE_COMPETENCY é validate-multiple

Emitido dentro dos últimos quantos meses?​

  • Tipo: number
  • Nome: COMPETENCY_PAST_MONTHS_COUNT
  • Valor Padrão: 3
  • Condições:
    • Quando VALIDATE_COMPETENCY é validate-multiple
    • Quando COMPETENCY_TYPE (variante múltipla) é month

Mês​

  • Tipo: select
  • Nome: COMPETENCY_MONTH
  • Condições:
    • Quando VALIDATE_COMPETENCY é validate-single
    • Quando COMPETENCY_TYPE é month
  • Opções:
    • Janeiro: 1
    • Fevereiro: 2
    • Março: 3
    • Abril: 4
    • Maio: 5
    • Junho: 6
    • Julho: 7
    • Agosto: 8
    • Setembro: 9
    • Outubro: 10
    • Novembro: 11
    • Dezembro: 12

Semestre​

  • Tipo: select
  • Nome: COMPETENCY_SEMESTER
  • Condições:
    • Quando VALIDATE_COMPETENCY é validate-single
    • Quando COMPETENCY_TYPE é semester
  • Opções:
    • 1º semestre: 1
    • 2º semestre: 2

Trimestre​

  • Tipo: select
  • Nome: COMPETENCY_QUARTER
  • Condições:
    • Quando VALIDATE_COMPETENCY é validate-single
    • Quando COMPETENCY_TYPE é quarter
  • Opções:
    • 1º trimestre: 1
    • 2º trimestre: 2
    • 3º trimestre: 3
    • 4º trimestre: 4

Ano​

  • Tipo: number
  • Nome: COMPETENCY_YEAR
  • Condições:
    • Quando VALIDATE_COMPETENCY é validate-single
    • Quando COMPETENCY_TYPE é month ou quarter ou semester ou year (aparece para qualquer tipo de competência escolhido)

Exemplos​

Valida uma única competência — holerite referente a setembro/2026 (quatro propriedades da mesma regra, quatro itens em rules):

curl --request POST 'https://api.dynadok.com/v1/api/documents' \
  --header 'x-api-key: 550e8400-e29b-41d4-a716-446655440000.SUA_CHAVE' \
  --form 'files=@"/caminho/holerite.pdf"' \
  --form 'type="HOLERITE"' \
  --form 'rules="[{\"type\":\"COMPETENCY\",\"inputName\":\"VALIDATE_COMPETENCY\",\"inputValue\":[\"validate-single\"]},{\"type\":\"COMPETENCY\",\"inputName\":\"COMPETENCY_TYPE\",\"inputValue\":[\"month\"]},{\"type\":\"COMPETENCY\",\"inputName\":\"COMPETENCY_MONTH\",\"inputValue\":[\"9\"]},{\"type\":\"COMPETENCY\",\"inputName\":\"COMPETENCY_YEAR\",\"inputValue\":[\"2026\"]}]"'

Valida mais de uma competência — exige 3 holerites mensais, aceitando apenas os emitidos dentro dos últimos 6 meses. COMPETENCY_PAST_MONTHS_COUNT só existe quando VALIDATE_COMPETENCY é validate-multiple e COMPETENCY_TYPE é month — as duas condições estão satisfeitas aqui:

curl --request POST 'https://api.dynadok.com/v1/api/documents' \
  --header 'x-api-key: 550e8400-e29b-41d4-a716-446655440000.SUA_CHAVE' \
  --form 'files=@"/caminho/holerite.pdf"' \
  --form 'type="HOLERITE"' \
  --form 'rules="[{\"type\":\"COMPETENCY\",\"inputName\":\"VALIDATE_COMPETENCY\",\"inputValue\":[\"validate-multiple\"]},{\"type\":\"COMPETENCY\",\"inputName\":\"COMPETENCY_TYPE\",\"inputValue\":[\"month\"]},{\"type\":\"COMPETENCY\",\"inputName\":\"COMPETENCY_COUNT\",\"inputValue\":[\"3\"]},{\"type\":\"COMPETENCY\",\"inputName\":\"COMPETENCY_PAST_MONTHS_COUNT\",\"inputValue\":[\"6\"]}]"'